fix(changelog): split entries mixing code fences with angle-bracket types#13727
Closed
devin-ai-integration[bot] wants to merge 3 commits into
Closed
fix(changelog): split entries mixing code fences with angle-bracket types#13727devin-ai-integration[bot] wants to merge 3 commits into
devin-ai-integration[bot] wants to merge 3 commits into
Conversation
The first changelog entry for v4.0.0 contained both a fenced code block and later inline backtick spans with angle brackets (Consumer<String>). The changelog sanitizer's backtick-parity tracking gets confused by code fences, causing it to double-wrap the angle-bracket type — which breaks MDX parsing in the docs repo (<String> is interpreted as a JSX tag). Fix: split the single large summary into two separate feat entries so the code fence and the Consumer<String> text are in different entries. Co-Authored-By: unknown <>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code review is billed via overage credits. To resume reviews, an organization admin can raise the monthly limit in Settings → Usage.
Once credits are available, reopen this pull request to trigger a review.
Entries that combine fenced code blocks with inline backtick spans containing angle brackets (e.g. Consumer<String>, OptionalNullable<T>, SyncPagingIterable<User>) get double-wrapped by sanitizeChangelogEntry, breaking MDX parsing in the docs repo. Fix: split affected entries so code fences and angle-bracket types are in separate summary blocks. This affects: - Java SDK v4.0.0: Consumer<String> after code fence - Java SDK v3.11.0: OptionalNullable<T> before code fences - Java SDK v0.10.1: SyncPagingIterable<User> between code fences Co-Authored-By: unknown <>
…ager.devin.ai/proxy/github.com/fern-api/fern into devin/1773924466-fix-changelog-text
devin-ai-integration
Bot
changed the title
Contributor
|
This PR is stale because it has been open 25 days with no activity. Remove stale label or comment or this will be closed in 5 days. |
github-actions
Bot
added
the
Stale
Contributor
|
This PR was closed because it has been inactive for 5 days after being marked stale. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Refs fern-api/docs#4342
Changelog entries that combine fenced code blocks (
```java...```) with inline backtick spans containing angle-bracket types (e.g.`Consumer<String>`) get double-wrapped bysanitizeChangelogEntry— the function's backtick-parity tracking gets confused by code fences, causing it to produce`Consumer(`Consumer<String>`)`which breaks MDX parsing in the docs repo (<String>is interpreted as a JSX tag).Changes Made
Split three affected entries so that code fences and angle-bracket types are processed independently by the sanitizer:
type: featentries, separating the code fence from theConsumer<String>textcollapse-optional-nullablesummary soOptionalNullable<T>is in one entry and the code fence examples are in a second entryaddedlist item soSyncPagingIterable<User>(which appeared between two code fences) starts a new list itemTesting
pnpm run check(biome) passesHuman Review Checklist
(feat):bullet points — the second one ("GenericonMessagehandler", "Binary WebSocket support", "Shared core types", etc.) loses the "Breaking change for WebSocket users only" context header.collapse-optional-nullableconfiguration and usage:" which is a bit artificial. Confirm this is acceptable in the rendered docs.addedlist split renders correctly. This splits anaddedlist item (not asummary), so confirm the changelog generator handles multipleaddeditems as expected.sanitizeChangelogEntry(not handling triple-backtick fences) still exists and will affect future entries that combine code fences with angle-bracket types in the same summary.Link to Devin session: https://app.devin.ai/sessions/5151f683b2dd4b19b266c84cb1aa999a